Flesh out documentation #285
Draft
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…undocumented types
credit to @stackotter for writing the original text in the Discord server
kaascevich
force-pushed
the
parameter-documentation
branch
from
bf7aca1 to
2634179
Compare
Contributor
Author
|
I'll probably wait to finish this PR until after the layout-performance branch is merged. |
Owner
Owner
|
Nvm you’ve already done that! |
…ith `Environment` type
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Right now, I've focused on adding documentation for parameters and return types, and documenting completely undocumented types. I'll improve on these (as well as the existing docs) as I become more familiar with SCUI's internals.